﻿/*
* Copyright (c) 2010-2012 Tesla Engine Group
* 
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
* 
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
* 
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/


using System;
using Tesla.Core;

namespace Tesla.Graphics.Implementation {
    /// <summary>
    /// Abstract class that represents a concrete implementation of a graphics resource.
    /// </summary>
    public abstract class GraphicsResourceImplementation : IDisposable {
        private String _name;
        private bool _isDisposed;
        private long _resourceID;

        /// <summary>
        /// Gets or sets the name of this resource.
        /// </summary>
        public String Name {
            get {
                return _name;
            }
            set {
                _name = value;
            }
        }

        /// <summary>
        /// Gets if the resource has been disposed.
        /// </summary>
        public bool IsDisposed {
            get {
                return _isDisposed;
            }
        }


        /// <summary>
        /// Gets or sets the resource ResourceID. It can only be set once, usually by the renderer.
        /// </summary>
        /// <exception cref="Tesla.Core.TeslaException">Thrown if the ID has already been set.</exception>
        public long ResourceID {
            get {
                return _resourceID;
            }
            set {
                if(_resourceID != -1) {
                    throw new TeslaException("Resource ID has already been set.");
                }
                _resourceID = value;
            }
        }


        /// <summary>
        /// Creates a new instance of <see cref="GraphicsResourceImplementation"/>.
        /// </summary>
        protected GraphicsResourceImplementation() {
            _isDisposed = false;
            _resourceID = -1;
        }


        /// <summary>
        /// Releases unmanaged resources and performs other cleanup operations before the
        /// <see cref="GraphicsResourceImplementation"/> is reclaimed by garbage collection.
        /// </summary>
        ~GraphicsResourceImplementation() {
            Dispose(false);
        }

        /// <summary>
        /// Disposes the underlying implementation.
        /// </summary>
        public void Dispose() {
            Dispose(true);
            GC.SuppressFinalize(this);
        }

        /// <summary>
        /// Releases unmanaged and - optionally - managed resources
        /// </summary>
        /// <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
        protected virtual void Dispose(bool disposing) {
            _isDisposed = true;
        }
    }
}
